Skip to content

Initial stab at mode documentation #3955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 30, 2025
Merged

Conversation

ccasin
Copy link
Contributor

@ccasin ccasin commented Apr 30, 2025

This adds some high-level documentation for our modes. The idea is to have a page that gives a brief overview of the whole suite of modes, without getting too far into the details of any one of them (for which it refers to the documentation about that particular feature).

I haven't attempted to write docs about the following axes: statefulness, visibility, yielding. Either someone else can write those and push them here, or they can be added in a future PR.

@ccasin ccasin added documentation Improvements or additions to documentation modes Work on modes. There's some overlap with the `multicore` label, but not strictly so. labels May 1, 2025
@ccasin
Copy link
Contributor Author

ccasin commented May 16, 2025

This is ready to merge, but let's wait until ccasin#3 is merged into it before hitting the button.

@goldfirere
Copy link
Collaborator

@goldfirere goldfirere enabled auto-merge (squash) May 30, 2025 19:32
@goldfirere goldfirere merged commit 8224b2c into ocaml-flambda:main May 30, 2025
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation modes Work on modes. There's some overlap with the `multicore` label, but not strictly so.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants